Move Xopt docs to this repo #1
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
pluflou
changed the title
There was a problem hiding this comment.
Pull Request Overview
This pull request moves the Xopt documentation into a dedicated repository and introduces a variety of example notebooks, API reference files, and continuous integration workflows for building and deploying the documentation.
- Adds multiple example notebooks covering Bayesian exploration, GP model creation, genetic algorithms, and basic generator usage.
- Introduces new API reference pages for major Xopt objects, including generators, evaluators, and VOCS.
- Configures GitHub Actions for building and deploying the documentation via MkDocs.
Reviewed Changes
Copilot reviewed 54 out of 54 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/examples/multi_objective_bayes_opt/mggpo.ipynb | New multi-objective Bayesian optimization example notebook |
| docs/examples/gp_model_creation/model_creation.ipynb | New notebook for building GP models; minor markdown typo detected |
| docs/examples/ga/nsga2.ipynb | New notebook for NSGA-II generator with a few typographical issues |
| docs/examples/bayes_exp/*.ipynb | Additional notebooks demonstrating Bayesian exploration |
| docs/api/* | New API reference pages for Xopt modules and classes |
| .github/workflows/gh-pages.yml | CI/CD workflow for building and deploying the docs |
| README.md | Updated repository title and description |
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This initializes the new repository for the Xopt docs site. The workflow in
gh-pages.ymlwould be triggered by thepypi_upload.ymlworkflows when a new Xopt version is released, as well as when a push/merge is made to the main branch.For this to be finalized:
xopt-org/Xoptrepo to add a token called "DEPLOY_DOCS" that authorizes the dispatch to this repo. The token needs to be fine-grain with read/write on the "Contents" permissions for this repo